Get quarantine state of Lot
Returns what holds the lot and what releasing it would release, so a release can be planned
before calling POST /v1/inventory/holds/lot/{lot_id}/release.
reasons lists every reason that holds the lot, the same list the Admin UI shows in the
Release Quarantine popup: the lot’s own lot-level hold first, then each open quarantine that
covers the lot through that hold (the lot kept its own older hold when the quarantine was
placed, or the nightly expiry check replaced its quarantine hold). The lot moves into such a
quarantine when its own hold ends. Pass hold_id values to reason_hold_ids of the release
call to release only some of them. Empty when the lot has no lot-level hold.
quarantined_with is the origin lot of the quarantine the lot is held in as a related lot.
related_lot_ids are the other lots whose holds the release call with release_cascaded=true
releases: the related lots held by the quarantine the lot started, or, after the lot was
released on its own, the related lots its quarantines still hold. While the lot is in a newer
quarantine of its own, only that quarantine’s related lots are listed.
leaving_related_lot_ids are the related lots of those quarantines that are held for another
reason as well: as Expired by the nightly expiry check, or by their own older hold. A release
with release_cascaded=true ends the quarantine, so these lots leave it and keep that hold.
still_quarantined_lot_ids are the related lots still quarantined with the lot after it was
released on its own: what POST /v1/inventory/holds/lot/{lot_id}/release-related-lots
releases or, for the lots in leaving_related_lot_ids, takes out of the quarantine. Empty
while the lot is in a quarantine of its own.
Lots of every merchant are returned, like the other holds endpoints.
Authorizations
Generate a JWT access token through a Custom Global Integration and provide it with each request in the Authorization header prefixed with "Bearer" and then a single space.
Path Parameters
Lot to look up.
Response
The quarantine state of the lot.
Lot that was looked up.
Reasons that hold the lot; empty when it has no lot-level hold.
Origin lot of the quarantine the lot is held in as a related lot (also while the
expiry check holds it as Expired); NULL when it is held in none.
Other lots whose holds the release call with release_cascaded=true releases.
Number of related_lot_ids.
Related lots that a release with release_cascaded=true takes out of a quarantine
while they keep another hold (their Expired hold or their own older hold).
Related lots still quarantined with the lot after it was released on its own, which
POST /v1/inventory/holds/lot/{lot_id}/release-related-lots releases or takes out
of the quarantine.